home *** CD-ROM | disk | FTP | other *** search
/ World of Video / World of Video.iso / gfxprograms / boards / retina / rblanke2.lha / RBlankers / RSpliner.doc < prev    next >
Text File  |  1994-07-12  |  13KB  |  317 lines
  1. RSpliner Manual
  2. ------------
  3.  
  4.  
  5.      NAME
  6.      ----    
  7.         SYS:WBStartup/Spliner
  8.  
  9.      SYNOPSIS
  10.      --------
  11.         RSpliner     CX_POPKEY=<HotKey>
  12.                      CX_POPUP=<YES | NO>
  13.                      BLANKKEY=<HotKey>
  14.                      TIMEOUT=<1 - 3600>
  15.                      CLIENTTIMEOUT=<1 - 60>
  16.                      LINES=<10 - 300>
  17.                      SPEED=<1 - 10>
  18.  
  19.     This software is FREEWARE.  It may be freely distributed for non-commercial use.        
  20.     All rights are reserved by the author.              
  21.    
  22.  
  23.      DESCRIPTION
  24.      -----------
  25.           RSpliner is a screen blanker with two levels of protection, the
  26.         first of which is an animation of a "qix" - an animated collection 
  27.     lines.  If the CPU is to busy, RSpliner will default to disabling the 
  28.     screen altogether, preventing the animation from burning into the 
  29.     screen.
  30.  
  31.  
  32.      REQUIREMENTS
  33.      ------------
  34.  
  35.           AmigaDOS 2.04 or better and a Retina graphics card.
  36.  
  37.       Retina software version 2.2.  Version 1.4 should still work but
  38.       is no longer being tested.
  39.  
  40.  
  41.      PURPOSE
  42.      -------
  43.  
  44.           RSpliner is a screenblanker.  
  45.           
  46.           A screen blanker's goal is to blank (disable) the screen output
  47.         in order to prevent burning images into the monitor's phosphor, but
  48.         just to disabling the screen is boring.  Instead, RSpliner displays a
  49.         configurable collection of moving lines to amuse you and to remind
  50.         you that the computer is still running.
  51.  
  52.  
  53.      STARTING
  54.      --------
  55.  
  56.           RSpliner is a Commodity, so it only runs under WB 2.04 and higher.
  57.         Just drop it in your WBStartup drawer so that it will load
  58.         automatically upon boot-up.  Just copy RSpliner and RSpliner.info to
  59.         SYS:WBStartup (or drag its icon to the WBStartup drawer).  It also
  60.         requires the Retina hardware and will not run if you don't have it.
  61.  
  62.           To start RSpliner without rebooting, just double-click on its icon.
  63.         If the Tool Types haven't been changed, a window will be displayed.
  64.         This is the "option panel" of RSpliner.  To see it blank the screen,
  65.         click on the "Blank" button.  To remove the option panel, click on
  66.         the "Hide" button.
  67.  
  68.           You can also start RSpliner from the CLI, just use the form:
  69.  
  70.                   RUN >NIL: <NIL: RSpliner {arguments}
  71.  
  72.           The arguments for CLI-Start are exactly the same as the
  73.         ToolTypes,  (See below)
  74.  
  75.  
  76.      ARGUMENTS
  77.      ---------
  78.  
  79.           RSpliner supports the standard Tool Type entries for commodities.
  80.         To set them, click on the RSpliner icon and select "Information" from
  81.         the Icons menu.  (Please refer to your AmigaDOS Manual for more
  82.         information on commodities and Tool Types.)
  83.  
  84.  
  85.           SUPPORTED TOOL TYPES:
  86.           ---------------------
  87.  
  88.           DONOTWAIT              When started from WBStartup, this lets WB
  89.                                  know that it shouldn't wait for RSpliner to
  90.                                  finish.  This tool type should >always< be
  91.                                  present.
  92.           
  93.           STARTPRI=<n>           This sets RSpliner' priority to "n".  "n"
  94.                                  should be a number between -120 and 120.
  95.                                  When started from WBStartup, this value
  96.                                  determines RSpliner priority in the
  97.                                  commodities list.  It should be a negative
  98.                                  number (i.e., low priority) so that all
  99.                                  other commodities have a chance to modify
  100.                                  the input stream before RSpliner sees it.
  101.  
  102.           CX_POPKEY=<HotKey>     This sets the key sequence that will open
  103.                                  RSpliner' option panel.  Please see below for
  104.                                  HotKey definitions.  Defaults to "shift
  105.                                  alt s".
  106.  
  107.           CX_POPUP=<YES | NO>    If this is set to "NO"  RSpliner will start
  108.                                  silently.  If it is set to anything else,
  109.                                  RSpliner will open its option panel when it
  110.                                  starts.
  111.  
  112.           BLANKKEY=<HotKey>      This defines the key sequence that will
  113.                                  instantly blank the screen.  Please see
  114.                                  below for HotKey definitions.  The default
  115.                                  blanking key is "lamiga s".
  116.  
  117.           TIMEOUT=<1 - 3600>     This sets the amount of time over which no
  118.                                  input events may occur in order for the
  119.                                  screen to blank.
  120.  
  121.           CLIENTTIMEOUT=<1 - 6>  This sets the maximum time RSpliner will try
  122.                                  to draw the animation.  If RSpliner can't
  123.                                  update the animation at least this often,
  124.                                  it will disable the screen.  This keeps
  125.                                  the lines from burning into the monitor,
  126.                                  and it also keeps RSpliner from wasting CPU
  127.                                  time when another program needs it.
  128.  
  129.           LINES=<10 - 300>       The number of lines in the Qix.
  130.  
  131.           SPEED=<1-10>           The speed (10 is fastest) of the Qix's
  132.                                  movement.
  133.  
  134.           NOTE: ToolTypes are case-sensitive, so make sure your
  135.         capitalization matches that shown above.
  136.  
  137.  
  138.      DEFAULT TOOL TYPES
  139.      ------------------
  140.  
  141.           When installed, RSpliner has the following Tool Types:
  142.  
  143.           DONOTWAIT              # Tell WB to not wait for RSpliner to finish.
  144.           CX_POPUP=YES           # Display the window when starting
  145.           STARTPRI=-120          # Sets a low CX priority for starting
  146.  
  147.  
  148.      HOT KEYS
  149.      --------
  150.  
  151.           Refer to your AmigaDOS Manual ("The Extras Programs/The Commodities
  152.         Drawer") to get a valid list of the available hot keys, the following 
  153.     may be obsolete with a new Commodities.library version:
  154.  
  155.         SYNOPSIS:  [<qualifier> [<qualifier>...]] <key>
  156.  
  157.              Qualifier keywords (Press and hold one or more qualifier)
  158.  
  159.              alt                 either Alt key
  160.              ralt                right Alt key
  161.              lalt                left Alt key
  162.              shift               either Shift key
  163.              rshift              right Shift key
  164.              lshift              left Shift key
  165.              capslock            Caps Lock key
  166.              rcommand            right Amiga key
  167.              lcommand            left Amiga key
  168.              control             Control key
  169.              numericpad          Enables the use of a key on the numeric
  170.                                  keypad
  171.              rbutton             Click (and hold) the right mouse button
  172.              midbutton           Click (and hold) the middle mouse button
  173.                                  (only avail for mice with three buttons.)
  174.              leftbutton          Click (and hold) the left mouse button
  175.              newprefs            Preferences changed
  176.              diskremoved         Disk removed
  177.              diskinserted        Disk inserted
  178.  
  179.  
  180.              Keys (to be pressed and released, only ONE Key can be chosen)
  181.  
  182.              a..z, 0..9, etc.    Normal keys
  183.              f1 .. f10           Function keys
  184.              up down left right  Cursor keys
  185.              help                Help key
  186.              del                 Delete key
  187.              return              Return key
  188.              enter               Enter key (MUST be combined with
  189.                                  'numericpad'!)
  190.              backspace           Backspace key
  191.              esc                 Escape key
  192.              space               Space key
  193.              comma               Comma key
  194.              upstroke            Upstroke key
  195.  
  196.  
  197.              Examples:
  198.  
  199.                   lalt ralt enter
  200.                   ramiga f10
  201.                   alt x
  202.                   lalt numericpad enter
  203.  
  204.           NOTE: Choose your hotkeys carefully.  Commodities can change the
  205.         way standard keys operate, and if you assign "a" to blank the
  206.         screen, then the screen will blank every time you push it - even
  207.         when you're trying to type.
  208.  
  209.           If you try to use an illegal hot key combination, RSpliner will not
  210.         start, but will display an error message, instead.  Some examples
  211.         of illegal hot keys are:
  212.  
  213.           lalt a b               # Two keys specified
  214.           leftbutton             # No key specified
  215.           control lcommand rcommand   # Reboots the system (oops!)
  216.  
  217.      EDIT WINDOW
  218.      -----------
  219.  
  220.           Some RSpliner settings can be changed while RSpliner is executing.  To
  221.         change the settings, open the RSpliner option window by pressing the
  222.         CX_POPKEY sequence you defined.  Changes made in the option window
  223.         will not be saved.
  224.  
  225.       When the option panel opens, you will see some gadgets and a
  226.     scrollable list of display modes.
  227.  
  228.           TIMER:                 The value for the timeout of the blanker.
  229.                                  After this time (in seconds) the blanker
  230.                                  will display the animation. TIMER may have a
  231.                                  value between between 1 and 3600.
  232.  
  233.           CLIENT TIMEOUT:        The time RSpliner gives the animation
  234.                                  routines to update the screen.  If the
  235.                                  animation routines exceed this limit, the
  236.                                  screen will be blacked out to prevent
  237.                                  burn-ins.
  238.  
  239.           SPEED:                 The maximum pixels per frame the lines will
  240.                                  move.
  241.  
  242.           LINES:                 The number of lines.
  243.  
  244.           HIDE:                  (click or press 'h') Closes the option
  245.                                  window, without stopping RSpliner.
  246.  
  247.           BLANK:                 (click or press 'b') Immediately blanks
  248.                                  the screen.
  249.  
  250.           QUIT:                  (click or press 'q') Quit.
  251.  
  252.      COMMODITIES EXCHANGE
  253.      --------------------
  254.  
  255.       With the Exchange tool, you can temporarly disable or permanently
  256.     kill RSpliner and other commodities.  Please refer to the AmigaDOS Manual
  257.     (Section AmigaDOS Reference and Workbench Programs) for further
  258.     information on Exchange.
  259.  
  260.      COMMON PROBLEMS
  261.      ---------------
  262.  
  263.      1)   You are running a C-Compiler or a raytracer.  RSpliner blanks but
  264.           doesn't show the lines, or the lines only appear erraticly.
  265.  
  266.           If the CPU usage is high, RSpliner will simply blank the screen.
  267.           This keeps RSpliner from degrading the speed of other processes, and
  268.           it prevents the animation from burning the monitor by getting stuck 
  269.       in one place too long.
  270.  
  271.           Another time this can occur is when you're using all the Retina's
  272.           video memory for other screens.  If this happens, RSpliner will
  273.           first try to open a low resolution screen instead of the normal
  274.           high res one.  If >that< fails, RSpliner will resort to simply
  275.           blanking the screen.
  276.      
  277.      2)   RSpliner blanks the screen, but the lines are all lo-res and chunky
  278.           looking. (whine whine)
  279.      
  280.           See the previous note.  If RSpliner can't open a high res screen, it
  281.           tries to open a low-res one.  If that fails, it just blacks out
  282.           the screen.
  283.  
  284.      3)   When a disk is inserted, RSpliner "unblanks".  This is normal.
  285.           Disk-replacement is detected as an input event. As all input
  286.           events disable the blanker, this one does as well.
  287.  
  288.      4)   RSpliner displays the window though the Tool Type CX_POPUP is set to
  289.           'NO'.
  290.  
  291.           This happens when RSpliner is started but another copy is already
  292.           running.
  293.  
  294.      CREDITS
  295.      -------
  296.  
  297.           Much of the code style and technique of this blanker was inspired
  298.         by the PD blanker ASwarmIII by Jake Rose.  He did a good job
  299.         showing me how it's done.
  300.  
  301.  
  302.      HISTORY
  303.      -------
  304.  
  305.     2.4:    Rebuilt under SAS 6.51.  Also, fixed a glitch in the building
  306.     of the NewBroker structure, which caused an enforcer hit inside
  307.     the commodities library.
  308.  
  309.                                    
  310.      AUTHOR
  311.      ------
  312.      
  313.           Michael Heinz
  314.       William Henry Apts, #OAK-123
  315.       Malvern, PA 19355
  316.       (610)-651-5361
  317.